Walkthrough

Adds a published PHP guide for connecting NOALBS to OpenRTMP JSON statistics, links it from the guides index, adds sitemap metadata, and includes the new URL in public-page smoke tests.

Changes

NOALBS guide publication

Estimated code review effort: 2 (Simple) | ~10 minutes

• Add a new guide for connecting NOALBS to OpenRTMP JSON stats endpoints.
• Link the guide from the guides landing page and include it in the sitemap.
• Extend the website smoke test to cover the new guide route.

graph TD
  A["Guides landing"] --> B["New NOALBS stats guide"] --> C["Header/Footer includes"]
  D["Sitemap.xml"] --> B
  E["CI site-checks workflow"] --> F["Smoke-test routes"] --> B

  subgraph Legend
    direction LR
    _page["Page"] ~~~ _cfg["Config/Index"] ~~~ _ci["CI"]
  end

Loading

The following are alternative approaches to this PR:

1. Auto-generate sitemap + smoke routes from guides directory

• ➕ Eliminates manual duplication across guides index, sitemap, and CI route lists
• ➕ Reduces risk of forgetting to add new guides to one of the discovery/validation locations
• ➖ Adds build-time logic (or runtime discovery) that may not fit a simple PHP/static workflow
• ➖ Requires defining metadata (title/description) in a machine-readable way for consistent generation

2. Centralize guide metadata in a single data file (JSON/PHP array)

• ➕ Single source of truth for cards, sitemap lastmod/changefreq, and test routes
• ➕ Keeps pages themselves focused on content
• ➖ Introduces a new content-maintenance step and conventions for contributors
• ➖ Still requires manual lastmod updates unless additional tooling is added

Recommendation: The PR’s approach is appropriate for the current site structure: add the guide, then wire it into the index, sitemap, and CI checks. If guide count grows, consider a single-source metadata approach (or generation) to avoid drift between navigation, sitemap, and smoke-test allowlists.

Tests (1) +1 / -0

site-checks.ymlInclude new guide route in CI smoke checks +1/-0

Include new guide route in CI smoke checks

• Adds the new /guides/openrtmp-noalbs-json-stats/ path to the list of URLs validated by the site-checks workflow.

.github/workflows/site-checks.yml

Documentation (2) +225 / -2

index.phpAdd NOALBS statistics guide card and refresh SEO copy +9/-2

Add NOALBS statistics guide card and refresh SEO copy

• Updates the guides landing page title/description to mention NOALBS. Adds a new guide card linking to the OpenRTMP/NOALBS JSON statistics guide.

guides/index.php

index.phpNew guide: OpenRTMP JSON stats integration with NOALBS +216/-0

New guide: OpenRTMP JSON stats integration with NOALBS

• Introduces a task-focused guide covering NOALBS v2.19.0+ native OpenRTMP provider setup, key usage (publish/play/stats), JSON endpoint fields, XML fallback configuration, host selection in Docker, and common HTTP/proxy troubleshooting.

guides/openrtmp-noalbs-json-stats/index.php

Other (1) +7 / -1

sitemap.xmlAdd new guide URL and update guides lastmod date +7/-1

Add new guide URL and update guides lastmod date

• Bumps the /guides/ lastmod date and adds a new sitemap entry for /guides/openrtmp-noalbs-json-stats/ with monthly change frequency.

sitemap.xml